Create Counterparty Group

POST /api/v1/Counterparties/groups

Description

This endpoint is used to create a new counterparty group.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Request Body:

• A CreateCounterpartyGroupRequest object containing the group details.

URL:

• POST: {{baseUrl API url}}/api/v1/Counterparties/groups

Response:

• A CounterpartyGroupResponse object containing the group details.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

POST /api/v1/Counterparties/groups
Content-Type: application/json
{
  "name": "Group A",
  "description": "This is a group for Counterparties"
}

Response:

HTTP/1.1 200 OK
{
  "id": "0987654321",
  "name": "Group A",
  "description": "This is a group for Counterparties"
}

Method: POST

/api/v1/Counterparties/groups

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "name": "<string>",
  "members": [
    {
      "counterpartyId": "<uuid>",
      "counterpartyName": "<string>"
    },
    {
      "counterpartyId": "<uuid>",
      "counterpartyName": "<string>"
    }
  ]
}

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "name": "<string>",
    "merchantId": "<uuid>",
    "id": "<uuid>"
  }
}